Download OpenAPI specification:Download
This PortRequestManagement API provides developers a way to query and update items related to port request activities.
Resources related to creating, reading, updating and deleting port requests and their associated activities.
Provides a list of port requests in the system.
The following is a list of fields from the port request and how they can be used within the search.
| $count | boolean Example: $count=true Specifies whether to fetch the total count of results. This is the count of all entities that match the |
| $filter | string Example: $filter=field1 eq 1234 A structured search expression in standard OData syntax. |
| $inlinecount | string Enum: "allpages" "none" Example: $inlinecount=allpages Tells the server to include the total count of matching entities in the response. |
| $orderby | string Example: $orderby=field1 A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order. |
| $select | string Example: $select=field1, field2 A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included. |
| $skip | number Example: $skip=10 Number of search results to skip. |
| $skiptoken | number Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search. |
| $top | number Example: $top=1 Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records. |
| Content-Type required | string Example: application/json |
{- "@count": 145,
- "value": [
- {
- "assignedUserID": "jdoe",
- "authorizedBy": "jdoe",
- "billAccountNumber": "123456",
- "billCompanyName": "My Company",
- "billFirstName": "John",
- "billingOrderID": 1,
- "billLastName": "Doe",
- "billMiddleInitial": "Q",
- "billPrefix": "Mr",
- "billSuffix": "Sr",
- "city": "Victor",
- "country": "USA",
- "createDate": "2008-10-27T16:03:36.443-04:00",
- "dueDate": "2008-10-27T16:03:36.443-04:00",
- "initiationDate": "2008-10-27T16:03:36.443-04:00",
- "lastActivityDate": "2008-10-27T16:03:36.443-04:00",
- "lastActivityReasonCode": "1B",
- "lastActivityReasonCodeID": 1,
- "lastActivityRemarks": "Port In Remarks",
- "lastActivityType": "Port In Created",
- "lastActivityTypeID": 1,
- "portID": "789-898",
- "portMessageID": "10-10-2000",
- "portRequestID": 1,
- "portServiceNumber": "5555555555",
- "portStatus": "Open",
- "portStatusID": 1,
- "portTimeZone": "ALA",
- "portTimeZoneID": 1,
- "portType": "PortIn",
- "serviceID": 8795,
- "serviceInformationItemID": 1,
- "serviceNumberOwner": "Carrier X",
- "serviceNumberOwnerID": 8,
- "state": "NY",
- "streetDirection": "N",
- "streetName": "Phillips Road",
- "streetNumber": 1,
- "zipCode": "14456"
}
], - "@nextLink": "https://api.idibilling.com/portrequestmanagement/{ennvironment}/api/odataquery?$filter=field1 eq"
}Provides the ability to retreive details about a specific port request.
| portRequestID required | number Example: 1 Unique identifier for the port request to retrieve. |
| Content-Type required | string Example: application/json |
{- "assignedUserID": "jdoe",
- "authorizedBy": "jdoe",
- "billAccountNumber": "123456",
- "billAccountPasswordPIN": "1234",
- "billCompanyName": "My Company",
- "billFirstName": "John",
- "billingOrderID": 1,
- "billLastName": "Doe",
- "billMiddleInitial": "Q",
- "billPrefix": "Mr",
- "billSuffix": "Sr",
- "city": "Victor",
- "country": "USA",
- "createDate": "2008-10-27T16:03:36.443-04:00",
- "dueDate": "2008-10-27T16:03:36.443-04:00",
- "initiationDate": "2008-10-27T16:03:36.443-04:00",
- "lastActivityDate": "2008-10-27T16:03:36.443-04:00",
- "lastActivityReasonCode": "1B",
- "lastActivityReasonCodeID": 1,
- "lastActivityRemarks": "Port In Remarks",
- "lastActivityType": "Port In Created",
- "lastActivityTypeID": 1,
- "portID": "789-898",
- "portMessageID": "10-10-2000",
- "portRequestID": 1,
- "portServiceNumber": "5555555555",
- "portStatus": "Open",
- "portStatusID": 1,
- "portTimeZone": "ALA",
- "portTimeZoneID": 1,
- "portType": "PortIn",
- "serviceID": 8795,
- "serviceInformationItemID": 1,
- "serviceNumberOwner": "Carrier X",
- "serviceNumberOwnerID": 8,
- "ssn": "123456789",
- "state": "NY",
- "streetDirection": "N",
- "streetName": "Phillips Road",
- "streetNumber": 1,
- "taxID": "123456789",
- "zipCode": "14456"
}Provides the ability to update details about a specific port request.
This operation uses the JSON Patch document structure for defining updates to the Message objects. Read more about JSON Patch (RFC 6902) Here.
Open or Pending ports of type PortIn that do not have a last activity type of Port In Cancel Submitted.The following is a list of properties that can be patched.
Note: Use this field to enter any remarks for the created port activity.
Note: This field cannot be removed if the associated service requires time zone for ports.
| portRequestID required | number Example: 1 Unique identifier for the port request to retrieve. |
| Content-Type required | string Example: application/json |
| op required | string Indicates what type of JSON Patch operation being requested. Valid values are |
| path required | string Path within the JSON document that should be modified. |
| value required | string If supplied, the new value to be used at the given path by the given operation. |
[- {
- "op": "replace",
- "path": "/field1",
- "value": "newValue"
}
]{- "assignedUserID": "jdoe",
- "authorizedBy": "jdoe",
- "billAccountNumber": "123456",
- "billAccountPasswordPIN": "1234",
- "billCompanyName": "My Company",
- "billFirstName": "John",
- "billingOrderID": 1,
- "billLastName": "Doe",
- "billMiddleInitial": "Q",
- "billPrefix": "Mr",
- "billSuffix": "Sr",
- "city": "Victor",
- "country": "USA",
- "createDate": "2008-10-27T16:03:36.443-04:00",
- "dueDate": "2008-10-27T16:03:36.443-04:00",
- "initiationDate": "2008-10-27T16:03:36.443-04:00",
- "lastActivityDate": "2008-10-27T16:03:36.443-04:00",
- "lastActivityReasonCode": "1B",
- "lastActivityReasonCodeID": 1,
- "lastActivityRemarks": "Port In Remarks",
- "lastActivityType": "Port In Created",
- "lastActivityTypeID": 1,
- "portID": "789-898",
- "portMessageID": "10-10-2000",
- "portRequestID": 1,
- "portServiceNumber": "5555555555",
- "portStatus": "Open",
- "portStatusID": 1,
- "portTimeZone": "ALA",
- "portTimeZoneID": 1,
- "portType": "PortIn",
- "serviceID": 8795,
- "serviceInformationItemID": 1,
- "serviceNumberOwner": "Carrier X",
- "serviceNumberOwnerID": 8,
- "ssn": "123456789",
- "state": "NY",
- "streetDirection": "N",
- "streetName": "Phillips Road",
- "streetNumber": 1,
- "taxID": "123456789",
- "zipCode": "14456"
}Updates the assignedUserID of the port to the assignee
| portRequestID required | number Example: 1 Unique identifier for the port request to change the assignment of. |
| Content-Type required | string Example: application/json |
| assignee | string The user to assign the port to. If empty the port will be unassigned. |
{- "assignee": "jdoe"
}{- "loggingNumber": 500032,
- "message": "You do not have access to foo ID 1 or it does not exist.",
- "field": "exampleField"
}Submits a cancel request for a port.
| portRequestID required | number Example: 1 Unique identifier for the port request to cancel. |
| Content-Type required | string Example: application/json |
| remarks | string Remarks associated with the request. |
{- "remarks": "Port request is under review."
}{- "loggingNumber": 500032,
- "message": "You do not have access to foo ID 1 or it does not exist.",
- "field": "exampleField"
}Submits a confirmation for a port out or port in.
Open or Pending ports of type PortOut that do not have a last activity type of Confirmation Submitted, Delay Notice Submitted, Port In Cancel Submitted, or Resolution Required Submitted.Pending ports of type PortIn that do not have a last activity type of Port In Cancel Submitted [Rev 1.07].| portRequestID required | number Example: 1 Unique identifier for the port request to confirm. |
| Content-Type required | string Example: application/json |
| description | string Information about confirmation response received from porting provider. Note
|
| remarks | string Remarks associated with the request. |
| responseNumber | string Response number issued by the porting provider. [Rev. 1.10] Note
|
{- "description": "Description of the request",
- "remarks": "Manually confirming port request per supervisor instruction."
}{- "loggingNumber": 500032,
- "message": "You do not have access to foo ID 1 or it does not exist.",
- "field": "exampleField"
}Submits a delay notification for a port out.
Open or Pending ports of type PortOut that do not have a last activity type of Confirmation Submitted, Delay Notice Submitted, Port In Cancel Submitted, or Resolution Required Submitted.| portRequestID required | number Example: 1 Unique identifier for the port request to delay. |
| Content-Type required | string Example: application/json |
| delayDate required | string Date port out is delayed until. NoteThis date must be in the future. |
| remarks | string Remarks associated with the request. |
{- "delayDate": "2008-10-27T16:03:36.443-04:00",
- "remarks": "Manually delaying port request per supervisor instruction."
}{- "loggingNumber": 500032,
- "message": "You do not have access to foo ID 1 or it does not exist.",
- "field": "exampleField"
}Updates port request with delay information received from the porting provider [Rev 1.08].
Open or Pending ports of type PortIn.| portRequestID required | number Example: 1 Unique identifier for the port request to delay. |
| Content-Type required | string Example: application/json |
| delayDate required | string Date port in is delayed until. NoteThis date must be in the future. |
| description | string Information about the delay received from the porting provider. |
| remarks | string Remarks associated with the request. |
| responseNumber | string Response number issued by the porting provider. [Rev. 1.10] |
{- "delayDate": "2008-10-27T16:03:36.443-04:00",
- "description": "Delay received",
- "remarks": "Delay received from porting provider.",
- "responseNumber": "01"
}{- "loggingNumber": 500032,
- "message": "You do not have access to foo ID 1 or it does not exist.",
- "field": "exampleField"
}Forces the status of a port in or port out request to canceled and, for port ins, bypasses the submission process.
| portRequestID required | number Example: 1 Unique identifier for the port request to force cancel. |
| Content-Type required | string Example: application/json |
| remarks | string Remarks associated with the request. |
{- "remarks": "Port request is under review."
}Forces the status of a port in or port out request to completed and, for port ins, bypasses the submission process.
| portRequestID required | number Example: 1 Unique identifier for the port request to force complete. |
| Content-Type required | string Example: application/json |
| remarks | string Remarks associated with the request. |
{- "remarks": "Port request is under review."
}{- "loggingNumber": 500032,
- "message": "You do not have access to foo ID 1 or it does not exist.",
- "field": "exampleField"
}Updates a port in request to have the specified initiation date.
| portRequestID required | number Example: 1 Unique identifier for the port request to retrieve. |
| Content-Type required | string Example: application/json |
| initiationDate | string Date the port should be initiated on.
|
| remarks | string Remarks associated with the request. |
{- "initiationDate": "2008-10-27T16:03:36.443-04:00",
- "remarks": "Initiating port request."
}{- "loggingNumber": 500032,
- "message": "You do not have access to foo ID 1 or it does not exist.",
- "field": "exampleField"
}Create a message associated to a port request [Rev 1.07].
| portRequestID required | integer Example: 1 Unique identifier for the port request to retrieve. |
| Content-Type required | string Example: application/json |
| createDate | string Date the message was received.
|
| messageBody required | string Contents of the message. |
| messageType required | string Type of port request message. |
{- "createDate": "2018-10-27T16:03:36.443-04:00",
- "messageBody": "Sample Message",
- "messageType": "ACK"
}{- "loggingNumber": 500032,
- "message": "You do not have access to foo ID 1 or it does not exist.",
- "field": "exampleField"
}For a port out, submits a resolution required notification. For a port in, this should be called when a require resolution request is received from the porting provider.
This operation can only be performed on Open or Pending ports of type PortOut that do not have a last activity type of Port In Cancel Submitted, Confirmation Submitted, Delay Notice Submitted or Resolution Required Submitted.
| portRequestID required | number Example: 1 Unique identifier for the port request to submit a require resolution request for. |
| Content-Type required | string Example: application/json |
| reasonCodeID required | number Unique identifier for a port request reason code to associate with this request. |
| remarks | string Remarks associated with the request. |
{- "reasonCodeID": 1,
- "remarks": "A resolution is required for this port request."
}{- "loggingNumber": 500032,
- "message": "You do not have access to foo ID 1 or it does not exist.",
- "field": "exampleField"
}For a port in, denotes that this port request requires additional information or clarification and that a notification has been received from the old service provider that requires resolution. [Rev 1.07]
This operation can only be performed on Pending ports of type PortIn that do not have a last activity type of Port In Cancel Submitted.
| portRequestID required | number Example: 1 Unique identifier for the port request to submit a require resolution received request for. |
| Content-Type required | string Example: application/json |
| reasonCode required | string The port reason code describing why this port in request requires resolution. |
| reasonDetail required | string A detailed description of why this port in request requires resolution. |
| remarks | string Remakrs associated with the request. |
| responseNumber | string Response number issued by the porting provider. [Rev. 1.10] |
{- "reasonCode": "6D",
- "reasonDetail": "string",
- "remarks": "A resolution is required for this port request.",
- "responseNumber": "01"
}{- "loggingNumber": 500032,
- "message": "You do not have access to foo ID 1 or it does not exist.",
- "field": "exampleField"
}Updates a port in request to have the specified due date.
Open or Pending ports of type PortIn that do not have a last activity type of Port In Cancel Submitted.| portRequestID required | number Example: 1 Unique identifier for the port request to update. |
| Content-Type required | string Example: application/json |
| dueDate | string New due date for the port. |
| remarks | string Remarks associated with the set due date request. |
{- "dueDate": "2008-10-27T16:03:36.443-04:00",
- "remarks": "Port needs additional time to process."
}{- "loggingNumber": 500032,
- "message": "You do not have access to foo ID 1 or it does not exist.",
- "field": "exampleField"
}Updates a port in request with error information received from response of the porting provider [Rev. 1.07].
Open or Pending ports of type PortIn that do not have a last activity type of Port In Cancel Submitted.| portRequestID required | integer Example: 1 Unique identifier for the port request to update. |
| Content-Type required | string Example: application/json |
| description required | string Information about error received from porting provider. |
| remarks | string Remarks associated with the request. |
| responseNumber | string Response number issued by the porting provider. [Rev. 1.10] |
{- "description": "RESPONSE_CODE: 00",
- "remarks": "Port In Error Received from porting provider.",
- "responseNumber": "01"
}{- "loggingNumber": 500032,
- "message": "You do not have access to foo ID 1 or it does not exist.",
- "field": "exampleField"
}Updates a port in request with information received from response from the porting provider [Rev 1.07].
Open or Pending ports of type PortIn that do not have a last activity type of Port In Cancel Submitted.| portRequestID required | integer Example: 1 Unique identifier for the port request to update. |
| Content-Type required | string Example: application/json |
| description required | string Information about response received from porting provider. |
| portID | string External identifier for the port request issued by the porting provider. [Rev. 1.10] |
| remarks | string Remarks associated with the request. |
| responseNumber | string Response number issued by the porting provider. [Rev. 1.10] |
{- "description": "RESPONSE_CODE: 00",
- "portID": "U1RFVkU=",
- "remarks": "Port In Response Received from porting provider.",
- "responseNumber": "01"
}{- "loggingNumber": 500032,
- "message": "You do not have access to foo ID 1 or it does not exist.",
- "field": "exampleField"
}Provides a list of port activities for a port request.
The following is a list of fields from the port request and how they can be used within the search.
| portRequestID required | number Example: 1 Unique identifier for the port request to retrieve port activities for. |
| $count | boolean Example: $count=true Specifies whether to fetch the total count of results. This is the count of all entities that match the |
| $filter | string Example: $filter=field1 eq 1234 A structured search expression in standard OData syntax. |
| $inlinecount | string Enum: "allpages" "none" Example: $inlinecount=allpages Tells the server to include the total count of matching entities in the response. |
| $orderby | string Example: $orderby=field1 A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order. |
| $select | string Example: $select=field1, field2 A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included. |
| $skip | number Example: $skip=10 Number of search results to skip. |
| $skiptoken | number Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search. |
| $top | number Example: $top=1 Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records. |
| Content-Type | string Example: application/json |
{- "@count": 145,
- "value": [
- {
- "createDate": "2008-10-27T16:03:36.443-04:00",
- "description": "",
- "dueDate": "2008-10-27T16:03:36.443-04:00",
- "portActivityID": 1,
- "portActivityType": "Port In Created",
- "portActivityTypeID": 1,
- "portID": "",
- "portReasonCode": "1B",
- "portReasonCodeID": 1,
- "portRequestID": 1,
- "portTimeZone": "ALA",
- "portTimeZoneID": 1,
- "remarks": "Port In Remarks",
- "responseNumber": "1234A",
- "userID": "jdoe"
}
], - "@nextLink": "https://api.idibilling.com/portrequestmanagement/{ennvironment}/api/odataquery?$filter=field1 eq"
}Provides the ability to retreive details about a specific port request activity.
| portRequestID required | number Example: 1 Unique identifier of the port request associated with the activity to retrieve. |
| portActivityID required | number Example: 1 Unique identifier for the port activity to retrieve. |
| Content-Type | string Example: application/json |
{- "createDate": "2008-10-27T16:03:36.443-04:00",
- "description": "",
- "dueDate": "2008-10-27T16:03:36.443-04:00",
- "portActivityID": 1,
- "portActivityType": "Port In Created",
- "portActivityTypeID": 1,
- "portID": "",
- "portReasonCode": "1B",
- "portReasonCodeID": 1,
- "portRequestID": 1,
- "portTimeZone": "ALA",
- "portTimeZoneID": 1,
- "remarks": "Port In Remarks",
- "responseNumber": "1234A",
- "userID": "jdoe"
}Provides a list of available port activity types available in the system.
The following is a list of fields from the port activity and how they can be used within the search.
| $count | boolean Example: $count=true Specifies whether to fetch the total count of results. This is the count of all entities that match the |
| $filter | string Example: $filter=field1 eq 1234 A structured search expression in standard OData syntax. |
| $inlinecount | string Enum: "allpages" "none" Example: $inlinecount=allpages Tells the server to include the total count of matching entities in the response. |
| $orderby | string Example: $orderby=field1 A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order. |
| $select | string Example: $select=field1, field2 A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included. |
| $skip | number Example: $skip=10 Number of search results to skip. |
| $skiptoken | number Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search. |
| $top | number Example: $top=1 Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records. |
| Content-Type required | string Example: application/json |
{- "@count": 145,
- "value": [
- {
- "description": "Port In Created",
- "isPortInActivity": true,
- "isPortOutActivity": false,
- "portActivityTypeID": 1
}
], - "@nextLink": "https://api.idibilling.com/portrequestmanagement/{ennvironment}/api/odataquery?$filter=field1 eq"
}Provides a list of port reason codes available in the system.
The following is a list of fields from the port reason code and how they can be used within the search.
| $count | boolean Example: $count=true Specifies whether to fetch the total count of results. This is the count of all entities that match the |
| $filter | string Example: $filter=field1 eq 1234 A structured search expression in standard OData syntax. |
| $inlinecount | string Enum: "allpages" "none" Example: $inlinecount=allpages Tells the server to include the total count of matching entities in the response. |
| $orderby | string Example: $orderby=field1 A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order. |
| $select | string Example: $select=field1, field2 A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included. |
| $skip | number Example: $skip=10 Number of search results to skip. |
| $skiptoken | number Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search. |
| $top | number Example: $top=1 Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records. |
| Content-Type required | string Example: application/json |
{- "@count": 145,
- "value": [
- {
- "description": "MDN not active",
- "portReasonCodeID": 11,
- "reasonCode": "6D"
}
], - "@nextLink": "https://api.idibilling.com/portrequestmanagement/{ennvironment}/api/odataquery?$filter=field1 eq"
}Provides a list of available port statuses available in the system. [Rev 1.01]
The following is a list of fields from the port status and how they can be used within the search.
| $count | boolean Example: $count=true Specifies whether to fetch the total count of results. This is the count of all entities that match the |
| $filter | string Example: $filter=field1 eq 1234 A structured search expression in standard OData syntax. |
| $inlinecount | string Enum: "allpages" "none" Example: $inlinecount=allpages Tells the server to include the total count of matching entities in the response. |
| $orderby | string Example: $orderby=field1 A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order. |
| $select | string Example: $select=field1, field2 A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included. |
| $skip | number Example: $skip=10 Number of search results to skip. |
| $skiptoken | number Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search. |
| $top | number Example: $top=1 Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records. |
| Content-Type required | string Example: application/json |
{- "@count": 145,
- "value": [
- {
- "description": "Open",
- "portStatusID": 1
}
], - "@nextLink": "https://api.idibilling.com/portrequestmanagement/{ennvironment}/api/odataquery?$filter=field1 eq"
}Provides a list of available port time zones available in the system.
The following is a list of fields from the port time zone and how they can be used within the search.
| $count | boolean Example: $count=true Specifies whether to fetch the total count of results. This is the count of all entities that match the |
| $filter | string Example: $filter=field1 eq 1234 A structured search expression in standard OData syntax. |
| $inlinecount | string Enum: "allpages" "none" Example: $inlinecount=allpages Tells the server to include the total count of matching entities in the response. |
| $orderby | string Example: $orderby=field1 A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order. |
| $select | string Example: $select=field1, field2 A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included. |
| $skip | number Example: $skip=10 Number of search results to skip. |
| $skiptoken | number Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search. |
| $top | number Example: $top=1 Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records. |
| Content-Type required | string Example: application/json |
{- "@count": 145,
- "value": [
- {
- "description": "Alaska",
- "portTimeZoneID": 1,
- "timeZone": "ALA"
}
], - "@nextLink": "https://api.idibilling.com/portrequestmanagement/{ennvironment}/api/odataquery?$filter=field1 eq"
}Provides a list of available service number owners available in the system.
The following is a list of fields from the service number owner and how they can be used within the search.
| $count | boolean Example: $count=true Specifies whether to fetch the total count of results. This is the count of all entities that match the |
| $filter | string Example: $filter=field1 eq 1234 A structured search expression in standard OData syntax. |
| $inlinecount | string Enum: "allpages" "none" Example: $inlinecount=allpages Tells the server to include the total count of matching entities in the response. |
| $orderby | string Example: $orderby=field1 A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order. |
| $select | string Example: $select=field1, field2 A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included. |
| $skip | number Example: $skip=10 Number of search results to skip. |
| $skiptoken | number Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search. |
| $top | number Example: $top=1 Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records. |
| Content-Type required | string Example: application/json |
{- "@count": 145,
- "value": [
- {
- "allowPortIns": true,
- "allowPortOuts": true,
- "description": "Alaska",
- "marketType": "Wireless",
- "marketTypeID": "2",
- "serviceNumberOwnerID": 1,
- "spid": "0001"
}
], - "@nextLink": "https://api.idibilling.com/portrequestmanagement/{ennvironment}/api/odataquery?$filter=field1 eq"
}Resources related to reading, updating, and deleting the Syniverse Porting Configuration.
Create the Syniverse Porting Configuration and restart the Syniverse Porting Workers.
| Content-Type required | string Example: application/json |
required | Array of objects (LRN) LRN Configuration |
required | object (MQClientConfiguration) MQ Client Connection Configuration |
required | object (PortingCustomer) Porting Customer Configuration |
| spid required | string Service Number Owner SPID |
{- "lrnConfiguration": [
- {
- "lrn": "1234",
- "tnLeadingDigits": "1234"
}
], - "mqClientConfiguration": {
- "channel": "1234",
- "host": "1234",
- "inputQueue": "1234",
- "outputQueue": "1234",
- "port": "1234",
- "queueManager": "1234"
}, - "portingCustomerConfiguration": {
- "implementationContactPhoneNumber": "555-555-5555",
- "portInDueDate": "30"
}, - "spid": "1234A"
}Retrieves the Syniverse Porting Configuration.
{- "lrnConfiguration": [
- {
- "lrn": "1234",
- "tnLeadingDigits": "1234"
}
], - "mqClientConfiguration": {
- "channel": "1234",
- "host": "1234",
- "inputQueue": "1234",
- "outputQueue": "1234",
- "port": "1234",
- "queueManager": "1234"
}, - "portingCustomerConfiguration": {
- "implementationContactPhoneNumber": "555-555-5555",
- "portInDueDate": "30"
}, - "spid": "1234A"
}portID to Port In Response.marketType and marketTypeID to Search Service Number Owners.responseNumber to Confirm Port Request, DelayReceived, List Port Activities, Port In Error, Port In Response, Require Resolution Received, and Retrieve Port Activity.spid to Search Service Number Owners.